Merge pull request #857 from cdr/web

[v2] Rewrite code-server to use new web stuff

Author: code-asher

.dockerignore

@@ -1,9 +1,10 @@
 Dockerfile
-# Docs
-doc/
-# GitHub stuff
+build
+deployment
+doc
 .github
 .gitignore
+.node-version
 .travis.yml
 LICENSE
 README.md

.gitignore

@@ -1,8 +1,3 @@
-/lib
 node_modules
-dist
-out
-.DS_Store
+build
 release
-.vscode
-.cache

.node-version

@@ -1 +1 @@
-10.15.1
+10.16.0

.npmrc

@@ -0,0 +1 @@
+scripts-prepend-node-path=true

.travis.yml

@@ -1,27 +1,26 @@
 language: node_js
 node_js:
-- 10.15.1
+- 10.16.0
 services:
 - docker
 matrix:
   include:
   - os: linux
     dist: trusty
     env:
-      - VSCODE_VERSION="1.33.1" MAJOR_VERSION="1" VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER-vsc$VSCODE_VERSION" TARGET="centos"
+      - VSCODE_VERSION="e8fc7db0d1e3f3a94b1cdcc136d146134b7a4c9a" MAJOR_VERSION="2" VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER" TARGET="linux"
   - os: linux
     dist: trusty
     env:
-      - VSCODE_VERSION="1.33.1" MAJOR_VERSION="1" VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER-vsc$VSCODE_VERSION" TARGET="alpine"
+      - VSCODE_VERSION="e8fc7db0d1e3f3a94b1cdcc136d146134b7a4c9a" MAJOR_VERSION="2" VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER" TARGET="alpine"
   - os: osx
     env:
-      - VSCODE_VERSION="1.33.1" MAJOR_VERSION="1" VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER-vsc$VSCODE_VERSION"
+      - VSCODE_VERSION="e8fc7db0d1e3f3a94b1cdcc136d146134b7a4c9a" MAJOR_VERSION="2" VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER"
 before_install:
-- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install libxkbfile-dev
-  libsecret-1-dev; fi
-- npm install -g [email protected]
+- if [[ "$TRAVIS_BRANCH" == "master" ]]; then export MINIFY="true"; fi
+- if [[ "$TRAVIS_BRANCH" == "master" ]]; then export PACKAGE="true"; fi
 script:
-- scripts/build.sh
+- scripts/ci.bash
 before_deploy:
 - echo "$VERSION" "$TRAVIS_COMMIT"
 - git config --local user.name "$USER_NAME"

Dockerfile

@@ -1,4 +1,6 @@
-FROM node:10.15.1
+FROM node:10.16.0
+ARG codeServerVersion=docker
+ARG vscodeVersion
 
 # Install VS Code's deps. These are the only two it seems we need.
 RUN apt-get update && apt-get install -y \
@@ -11,9 +13,10 @@ RUN npm install -g [email protected]
 WORKDIR /src
 COPY . .
 
-# In the future, we can use https://github.com/yarnpkg/rfcs/pull/53 to make yarn use the node_modules
-# directly which should be fast as it is slow because it populates its own cache every time.
-RUN yarn && NODE_ENV=production yarn task build:server:binary
+RUN yarn \
+	&& MINIFY=true yarn build "${vscodeVersion}" "${codeServerVersion}" \
+	&& yarn binary "${vscodeVersion}" "${codeServerVersion}" \
+	&& mv "/src/build/code-server${codeServerVersion}-vsc${vscodeVersion}-linux-x86_64-built/code-server${codeServerVersion}-vsc${vscodeVersion}-linux-x86_64" /src/build/code-server
 
 # We deploy with ubuntu so that devs have a familiar environment.
 FROM ubuntu:18.04
@@ -30,24 +33,25 @@ RUN apt-get update && apt-get install -y \
 	wget
 
 RUN locale-gen en_US.UTF-8
-# We unfortunately cannot use update-locale because docker will not use the env variables
+# We cannot use update-locale because docker will not use the env variables
 # configured in /etc/default/locale so we need to set it manually.
 ENV LC_ALL=en_US.UTF-8
 
 RUN adduser --gecos '' --disabled-password coder && \
 	echo "coder ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/nopasswd
 
 USER coder
-# We create first instead of just using WORKDIR as when WORKDIR creates, the user is root.
+# We create first instead of just using WORKDIR as when WORKDIR creates, the
+# user is root.
 RUN mkdir -p /home/coder/project
 
 WORKDIR /home/coder/project
 
-# This assures we have a volume mounted even if the user forgot to do bind mount.
-# So that they do not lose their data if they delete the container.
+# This ensures we have a volume mounted even if the user forgot to do bind
+# mount. So that they do not lose their data if they delete the container.
 VOLUME [ "/home/coder/project" ]
 
-COPY --from=0 /src/packages/server/cli-linux-x64 /usr/local/bin/code-server
-EXPOSE 8443
+COPY --from=0 /src/build/code-server /usr/local/bin/code-server
+EXPOSE 8080
 
-ENTRYPOINT ["dumb-init", "code-server"]
+ENTRYPOINT ["dumb-init", "code-server", "--host", "0.0.0.0"]

README.md

@@ -1,92 +1,133 @@
-# code-server [!["Open Issues"](https://img.shields.io/github/issues-raw/cdr/code-server.svg)](https://github.com/cdr/code-server/issues) [!["Latest Release"](https://img.shields.io/github/release/cdr/code-server.svg)](https://github.com/cdr/code-server/releases/latest) [![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cdr/code-server/blob/master/LICENSE) [![Discord](https://img.shields.io/discord/463752820026376202.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/zxSwN8Z)
+# code-server · [![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cdr/code-server/blob/master/LICENSE) [!["Latest Release"](https://img.shields.io/github/release/cdr/code-server.svg)](https://github.com/cdr/code-server/releases/latest) [![Build Status](https://img.shields.io/travis/com/cdr/code-server/master)](https://github.com/cdr/code-server)
 
-**code-server v2 is almost out!**
-[Get the preview here](https://github.com/cdr/code-server/releases).
-(Linux builds only at the moment.)
-
-`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a remote server, accessible through the browser.
+`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a
+remote server, accessible through the browser.
 
 Try it out:
 ```bash
-docker run -it -p 127.0.0.1:8443:8443 -v "${HOME}/.local/share/code-server:/home/coder/.local/share/code-server" -v "${PWD}:/home/coder/project" codercom/code-server --allow-http --no-auth
+docker run -it -p 127.0.0.1:8080:8080 -v "${HOME}/.local/share/code-server:/home/coder/.local/share/code-server" -v "$PWD:/home/coder/project" codercom/code-server
 ```
 
-- Code on your Chromebook, tablet, and laptop with a consistent dev environment.
-	- If you have a Windows or Mac workstation, more easily develop for Linux.
-- Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
-- Preserve battery life when you're on the go.
-	- All intensive computation runs on your server.
-	- You're no longer running excess instances of Chrome.
+- **Consistent environment:** Code on your Chromebook, tablet, and laptop with a
+  consistent dev environment. develop more easily for Linux if you have a
+  Windows or Mac, and pick up where you left off when switching workstations.
+- **Server-powered:** Take advantage of large cloud servers to speed up tests,
+  compilations, downloads, and more. Preserve battery life when you're on the go
+  since all intensive computation runs on your server.
 
-![Screenshot](/doc/assets/ide.png)
+![Screenshot](/doc/assets/ide.gif)
 
 ## Getting Started
-
-[![Create a Droplet](./doc/assets/do-new-droplet-btn.svg)](https://marketplace.digitalocean.com/apps/code-server?action=deploy)
-
 ### Run over SSH
-
 Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
 
 ### Docker
+See the Docker one-liner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile).
 
-See docker oneliner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile).
+To debug Golang using the
+[ms-vscode-go extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go),
+you need to add `--security-opt seccomp=unconfined` to your `docker run`
+arguments when launching code-server with Docker. See
+[#725](https://github.com/cdr/code-server/issues/725) for details.
 
 ### Binaries
-
-1.  [Download a binary](https://github.com/cdr/code-server/releases) (Linux and OS X supported. Windows coming soon)
-2.  Start the binary with the project directory as the first argument
-
-    ```
-    code-server <initial directory to open>
-    ```
-	> You will be prompted to enter the password shown in the CLI
-	`code-server` should now be running at https://localhost:8443.
-
-	> code-server uses a self-signed SSL certificate that may prompt your browser to ask you some additional questions before you proceed. Please [read here](doc/self-hosted/index.md) for more information.
-
-For detailed instructions and troubleshooting, see the [self-hosted quick start guide](doc/self-hosted/index.md).
-
-Quickstart guides for [Google Cloud](doc/admin/install/google_cloud.md), [AWS](doc/admin/install/aws.md), and [DigitalOcean](doc/admin/install/digitalocean.md).
-
-How to [secure your setup](/doc/security/ssl.md).
-
-## Development
-
-### Known Issues
-
+1. [Download a binary](https://github.com/cdr/code-server/releases). (Linux and
+    OS X supported. Windows coming soon)
+2. Unpack the downloaded file then run the binary.
+3. In your browser navigate to `localhost:8080`.
+
+- For self-hosting and other information see [doc/quickstart.md](doc/quickstart.md).
+- For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md).
+
+### Build
+- If you also plan on developing, set the `OUT` environment variable. Otherwise
+  it will build in this directory which will cause issues because `yarn watch`
+  will try to compile the build directory as well.
+- For now `@coder/nbin` is a global dependency.
+- Run `yarn build ${vscodeVersion} ${codeServerVersion}` in this directory (for
+  example: `yarn build 1.36.0 development`).
+- If you target the same VS Code version our Travis builds do everything will
+  work but if you target some other version it might not (we have to do some
+  patching to VS Code so different versions aren't always compatible).
+- You can run the built code with `node path/to/build/out/vs/server/main.js` or run
+  `yarn binary` with the same arguments in the previous step to package the
+  code into a single binary.
+
+## Known Issues
+- Uploading .vsix files doesn't work.
 - Creating custom VS Code extensions and debugging them doesn't work.
-- To debug Golang using [ms-vscode-go extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go), you need to add `--security-opt seccomp=unconfined` to your `docker run` arguments when launching code-server with Docker. See [#725](https://github.com/cdr/code-server/issues/725) for details.
+- Extension profiling and tips are currently disabled.
 
-### Future
+## Future
 - **Stay up to date!** Get notified about new releases of code-server.
   ![Screenshot](/doc/assets/release.gif)
 - Windows support.
 - Electron and Chrome OS applications to bridge the gap between local<->remote.
 - Run VS Code unit tests against our builds to ensure features work as expected.
 
-### Extensions
-
-At the moment we can't use the official VSCode Marketplace. We've created a custom extension marketplace focused around open-sourced extensions. However, if you have access to the `.vsix` file, you can manually install the extension.
+## Extensions
+At the moment we can't use the official VS Code Marketplace. We've created a
+custom extension marketplace focused around open-sourced extensions. However,
+you can manually download the extension to your extensions directory. It's also
+possible to set your own marketplace URLs by setting the `SERVICE_URL` and
+`ITEM_URL` environment variables.
 
 ## Telemetry
-
-Use the `--disable-telemetry` flag or set `DISABLE_TELEMETRY=true` to disable tracking ENTIRELY.
-
-We use data collected to improve code-server.
+Use the `--disable-telemetry` flag to completely disable telemetry. We use the
+data collected to improve code-server.
 
 ## Contributing
+### Development
+```shell
+git clone https://github.com/microsoft/vscode
+cd vscode
+git checkout <see travis.yml for the VS Code version to use here>
+git clone https://github.com/cdr/code-server src/vs/server
+cd src/vs/server
+yarn patch:apply
+yarn
+yarn watch
+# Wait for the initial compilation to complete (it will say "Finished compilation").
+# Run the next command in another shell.
+yarn start
+# Visit http://localhost:8080
+```
 
-Development guides are coming soon.
+If you run into issues about a different version of Node being used, try running
+`npm rebuild` in the VS Code directory and ignore the error at the end from
+`vscode-ripgrep`.
+
+### Upgrading VS Code
+We patch VS Code to provide and fix some functionality. As the web portion of VS
+Code matures, we'll be able to shrink and maybe even entirely eliminate our
+patch. In the meantime, however, upgrading the VS Code version requires ensuring
+that the patch still applies and has the intended effects.
+
+To generate a new patch, **stage all the changes** you want to be included in
+the patch in the VS Code source, then run `yarn patch:generate` in this
+directory.
+
+Our changes include:
+- Change the remote schema to `code-server`.
+- Allow multiple extension directories (both user and built-in).
+- Modify the loader, websocket, webview, service worker, and asset requests to
+  use the URL of the page as a base (and TLS if necessary for the websocket).
+- Send client-side telemetry through the server and get the initial log level
+  from the server.
+- Add an upload service for use in editor windows and the explorer along with a
+  file prefix to ignore for temporary files created during upload.
+- Make changing the display language work.
+- Make hiding or toggling the menu bar possible.
+- Make it possible for us to load code on the client.
+- Modify the build process to include our code.
 
 ## License
-
 [MIT](LICENSE)
 
 ## Enterprise
-
-Visit [our website](https://coder.com/) for more information about our enterprise offering.
+Visit [our enterprise page](https://coder.com/enterprise) for more information
+about our enterprise offering.
 
 ## Commercialization
-
-If you would like to commercialize code-server, please contact [email protected].
+If you would like to commercialize code-server, please contact
+[email protected].