phcode-dev/phoenix

Phoenix is a modern open-source Code Editor for the web, built for the browser.

phoenix's Issues

Fix console log errors with missing require configs

The following console error was noted.

Fix

The require configs are optional. Create an empty requirejs-config.json file {} in each extension folder to fix the error.

Similar to #109

Move default project creation to VFS

Default project is the project loaded if phoenix can't find any other projects in scope.

• #23

Setup lint task pre-push

eslint must run before a push is initialed.
We have removed this feature as part of node upgrade in the below pull requests.

Fix extension loading issues when phoenix is loaded from a web server.

• Load default extensions #54
• Fix theme loading issues #57
• Enable all default extensions. #57

Default extensions disabling workflow is broken

Upgrade to ES6 modules

Add support for ES6 Modules in all of the core code.

Remove defaultExtensions build task

• This is yet another method for managing default extensions. Deleting in favor of unified build management tools

Support for downloadable extension library.

Browser migration

Browser does not have nodejs env. We have to create remove node dep from brackets to port to the browser while maintaining the feature compatibility.

Stage 1 - Node runtime removal

Remove deprecated npm flows

• #9

Remove all node based default extensions.

• brackets-eslint removed as part of this change
• php tooling removed. Will not merge in phoenix core till we have dev request. #8
• #7
• #13
• #14
• #15
• #16

Direct integration for their party deps instead of old NPM

• #40

Stage 2 - brackets functionality reinstate with node alternative libs in the browser

Build Nodejs compatibility layer in browser

• #19
• #3
• #18

Migrate functionality

• #22
• #24
• #26
• #56
• #58
• #27
• #29
• #10

Reinstate functionality

• #51
• #52
• #209 - replaced with JSHint, marking as done as linter support is enaled. ESLint will be enabled only in installed builds.
• #39
• #38
• #47
• #67
• #74

Javascript refactoring is broken after js code hints extension was removed.

Remove old NPM based third-party installs.

As we are using deprecated node version 6.17, we need to remove old npm-based deps to enable node to upgrade. The deps in the third-party folder are tested and functional, so we will be keeping a copy in the source.

Reinstating functionality is done in #10

• Code mirror #41
• less #42
• preact-compat #43
• simulate-event #43
• extend #43
• acorn #43
• preact #44
• preact-test-utils #44
• semver.browser.js #44

Phoenix IDE: Double permission prompt to open project in write mode

This is a limitation of FS Access APIS.

To track: WICG/file-system-access#89

no-host server is integrated in source, there should be a way to dynamically upgrade it.

The server is integrated as a file directly into src/nohost-sw.js . This is as the server had issues when we copied it to the third-party folder.
Related to no-host server integration: #18
We should:

• Allow dynamic updates of the dependency.
• Move to third party folder.

Remove auto update extension in favor of web update

As phoenix is designed to work from a static web page, we will be using native browser-based update mechanisms.

disable paste context menus in firefox.

Firefox does not support js initiated clipboard paste other than via extensions. Ctrl-c, Ctrl-V works though.

We should remove paste context menus from browsers that do not support navigator.clipboard functionality.

• Edit>paste menu
• document right click> paste
  @abose

Port live view functionality.

• stage 1: Enable live reload on changes to file.
• stage 2: Live view without page reload functionality.

prerequisites:

#18

• #34

help menu

Reinstate functionality removed as part of browser migration.

Create an experimental build tag at the top of the page.

• We need to communicate the alpha status of the builds. Please see below screenshot on the UI.
  

Large folders rename, copy and move issues in fs native libs

Large folders like node modules copy will result in a large number of copy errors. This is likely due to file descriptor overflows in the os. Similarly, rename with drag and drop of large node modules folder errors out in phoenix.

Possible fixes:

1. Retry on failure with set immediate apis.
2. Limit runtime error logging as it will reduce the number of errors to only 11 while copying 44,000 files instead of 10k range of failures.
3. Changing parallel to serial copy using await on just the folders seriously reduced the speed of copy from 44k files in under 5 seconds to 1800 files in 2 minutes. Not recommended.
4. Batch copies to like 1000 concurrent fileops happening at a time.

Deprecte JavaScriptCodeHints extension

Deprecate JavaScriptCodeHints extension based on node.

future action

• We will be depending on "browser-hosted" language server protocol for code intelligence.

Code quality checks

Currently, we integrate with codacy for static analysis. Evaluate options:

• https://sonarcloud.io/

Remove OpenWithExternalApplication extension

• The extension is based on custom platform-specific appshell/node code.
• We cant really launch generic applications from the browser, applications would need to register custom URL protocols in the user's machine. Such configurations are not reliable right now. Deprecating this feature till there is a web stantard way to do this.

Release management

• Release scripts
• Release/dev/prod configs
• Google analytics id prod switches.

references

• https://github.com/release-it/release-it

Remove npm-shrinkwrap based package locks to enable node upgrade

• brackets use an old version of node before the availability of package-locks.
• In order to facilitate phoenix to upgrade to the latest node, we need to deprecate npm-shrinkwrap-based workflow.

Fix file system watchers.

Update PWA UX

PWA support for chrome was added in #101

The install UI should be inline with brackets ux.

Port notes

TODO:

• Update bootstrap to css than hardcoded.
• DefaultMenus.js : // TODO: add js handlers for copy and paste using browser standards.
• DebugCommands extension seems to not translate well to browser. reevaluate
• Large number of jquery error for extension loading displayed in console. we need to fix it. #26

Extensions removed:

Build tools removed:

• tasks/build.js tasks(build-prop, cla-check-pull, cla-check, nls-check
  • cla checks removed as we will be using github CI for cla checks.
  • Generate build number based on git commit id, git branch
  • translation completion check- check that src/nls/root keys are avilable in all other nls folders.
• update-release-number.js task(update-release-number)
  • API version and general version. see removed code for details

submodule to module notes:

• jslint submodule is based on an old version. We should consider deprecating the current jslint version in brackets and import the latest jslint
• mustache use bower/other to dynamically update deps.
• update 3p lib url = https://github.com/jrburke/requirejs.git
• update 3p lib https://github.com/requirejs/text.git
• update 3p lib url = https://github.com/requirejs/i18n.git

Notes

• usdin yarn as it flattens node module deps in a browser friendly way

Unify dependency management

Modern dependency management

Brackets currently have redundant dep management which is creating unnecessary build complexity. We need to address this. More details can be found here: adobe/brackets#12006 . This is preventing the upgrade of several dependencies to the latest version.

solutions

• Nuke git submodules- done. Copied code as-is for the time being the third party folder. There are no node modules, so safe.
• update mechanism for third party libs is done, we need to use it for all items tracked in this issue: #10
• #9
• #12
• npm-install-extensions grunt task removed
• #31
• #32
• #85
• #91

Remove native menus in favor of html menus

As phoenix is web-only, removing platform specific menu impls.

02644ba

QA: phoenix sanity check on 13/8/2021

Bracket Debug test that pass and fail are listed here

Dynamic upgrade solution for Third party deps

We have nuked git submodules and old npm-based third-party dependencies. we should be able to update our third-party deps dynamically and without much effort. Investigate ways to do this.

part of #5

in third party

• requirejs-i18n
• mustache
• path-utils - no need to upgrade. Custom brackets impl.
• requirejs
• requirejs-text
• Filer
• Code mirror #41
• less #42
• preact-compat #43
• simulate-event #43
• extend #43
• acorn #43
• Idb lib: https://github.com/jakearchibald/idb
• Buffer lib merged in as part of #107

References

• #40

Optimizations

• Minification for release builds (Remove unwanted source maps/src files)

Remove grunt build tools

Phoenix system usage metrics.

Phoenix virtual file system(VFS)

In browser virtual file system

Phoenix will have a virtual in browser fs API compatible with nodeJS FS APIs. Currently, this is implemented with filer lib with indexedDB as the data storage backend. We will be adding support for the latest native file system access API in filer via #3 which will add local file access to phoenix leveraging the latest browser tech(Some limitations present, fs watch not supported in the browser yet). This issue tracks all tasks related to VFS creation in phoenix.

• #20
• #21

javascript codehints

• Evaluate language server
• JSUtils have undergone heavy refactoring. Check functionality.

Update testing framework.

Filer seems to have a good testing framework. Does it suit to run brackets tests: https://github.com/filerjs/filer/blob/develop/CONTRIBUTING.md

Remove brackets usage tracking health data extension.

Remove brackets user analytics health data extension. We might want to consider some other way to obtain phoenix feature usage information for improving phoenix.

Modernise node

We have removed node deps for brackets runtime launch.

• #90

Php tooling extension removed

Php tooling extension was removed as it was breaking builds due to possible private deps. As we are not targeting PHP as a primary dev env right now, removing the PHP extension.

Copy paste functionality is broken

Appcache to improve loading performance

We should integrate with html5 app cache to improve our offline experience.

https://www.html5rocks.com/en/tutorials/appcache/beginner/

FS file system access naive api for the browser

Raised issue with filer to evaluate using it as our fs backend.
filerjs/filer#786

tracking project at aicore

• https://github.com/aicore/filer/projects/1
• FS access apis does not have rename/move support yet. raised an issue in WICG/FS access for the same.

Create phoenix virtual server to serve http/s traffic

• Phoenix virtual server based on no-host server already integrated into phoenix.
• Should serve files from native mount points.
• Remove nohost server.

Archive adobe/brackets for historical records

• https://github.com/brackets-archive created to mirror adobe/brackets related repos
• Mirrors all publically available data from Github.

• Mirrored repos
• Mirrored wikis
• Mirrored issues in brackets-shell
• Mirrored issues in brackets
• Backup all publically available extensions. https://github.com/brackets-archive/brackets-registry/releases/tag/extensions

Delete files functionality is not working.

Remove StaticServer extension

• Static servers are not possible with the current web application framework
• Remove StaticServer default extension.

notes

It is used for the experimental multi-browser live preview feature. But the multi-browser feature will not work anyway within browsers with the current web tech.

A possible option is to have a backend server from core.ai to proxy the requests(either at core.ai or phoenix agent locally installed(defeating the purpose of a true web app)), but it might be less instant, need to evaluate alternatives.

Reinstate browser native server functionality for live view.

Reinstate browser native server functionality for live view.
We can simulate a web server in the browser using a mix of service workers and file system emulation layer pioneered by Mozilla bramble.

Related reading: https://humphd.github.io/browser-shell/
https://github.com/humphd/nohost

Image previews are not working

Problem 1

• open a project with images.
• Select any image in the project, the image is not drawn.

Problem 2

• Open any HTML file with an img tag.
• hover over the image tag. an image preview should appear.

We should fix the above workflows to get image previews.

language server support in the browser.

Language server support is essential for the future of phcode.dev. Language servers brings in code auto completion and advanced code assistance features inside phoenix. Almost all implementations currently in existence require node and the few that work in the browser(ts language server) run only in vscode.dev.

We should find a way to browserify popular language servers in pure browser-based environments. This will help web-based code editors like us and others to provide advanced IDE-like features in the browser.

Language server in Browser and mobile devices

While this is fairly possible if we have a node engine(Eg. in native windows/mac/Linux) builds, We will hit a roadblock if we have to deploy a code editor in the browser or mobile devices like android or ios.

The best case is to be able to run language servers in the browser. As browser environments are readily available in mobile platforms as well as desktops/servers, this will help develop a universal language server component that can work in any device with a browser environment.

Feature requirements Phase 1

Phoenix should support the following language servers out of the box as a pure browser client:

• Generic infrastructure to run language servers in browser and language server client for phcode.dev
• Should work in mobile/desktop browsers and web views.
• Language intelligence should be in the web worker when possible.
• Account for Remote language server support for remote/cloud projects.
• Typescript/Javascript language server integration based on our in-browser LSP infra. Javascript code intelligence in phoenix is best to be deprecated in favor of an LSP-based implementation.

Feature requirements Phase 2

• Angular Language Service
• React language server. This appears to come free with Typescript language server. Phoenix currently has limited support for react language intelligence with our own implementation using ternjs.
• Extensibility API for third party language servers integration
• vue/vite/other frameworks that are in demand by our users.

Related issues:

1. #587
2. #682
3. #166
4. #8
5. #762

Load Phoenix from a web server instead of `file:///` URL within the brackets shell

• Fallback to file URLs if the server is not found.
• Test suite should function as is in the brackets shell.