Remove some circular dependencies #10641

le717 · 2015-02-20T18:32:33Z

(Branched off discussion in #10600)

isCSSPreprocessorFile() -> CSSUtils
_isStatic/ServerHtmlFileExt() -> LiveDevelopment
- Possibly change to be based on language id instead of file ext
getSmartFileExtension() -> LanguageManager, and maybe rename to something like getCompoundFileExtension() for clarity
Move just showFileOpenError() to DocumentCommandHandlers, next to _showSaveFileError()
Update all affected tests/JSDoc

To note, moving showFileOpenError() to DCH and _isStaticHtmlFileExt() to LiveDevelopmentUtils are creating a circular dependencies (sigh) during deprecation.

Once merged, I suggest these APIs are put on the fast track for removal so the cycles they will resolve (and temporarily create/prolong) are removed.

/cc @peterflynn

peterflynn · 2015-02-20T19:28:47Z

isCSSPreprocessorFile() isn't used in any extensions, so I think that one we can flat-out remove now, avoiding the need to deal with a new (albeit temporary) cycle.

le717 · 2015-02-20T20:16:51Z

Done. I just noticed that _isStatic/ServerHtmlFileExt() is also used by LiveDevMultiBrowser, so relocating them to LiveDevelopment is a no-go, since we don't want one live dev feeding off the other. Maybe the original plan of moving them to LanguageManager will do?

Also, are these functions used by any extensions? I can't check (don't have the catalog on my computer). If not, we can outright move these too.

peterflynn · 2015-02-20T20:29:53Z

@le717 They're very coupled to Live Preview, so I'd like to keep them located there if possible.

The module 'LiveDevelopment/main.js' is a common module between the two impls, but since it depends on them already we'd create a cycle by putting common code there and having the impls depend back on it. There's a tremendous amount of duplicated code between the two impls, so I assume we'll eventually want a common place to put code they both share (unless we're sure the old impl will entirely go away soon, but I don't see a clear path for that yet). Maybe starting a new module like LiveDevelopmentUtils or LiveDevelopmentCore would be worth it.

isStaticHtmlFileExt() is used by three extensions.

le717 · 2015-02-20T20:50:04Z

While there is indeed a lot of duplicated code, I do not feel comfortable attempting to consolidate that. Already I can see small functions that, if moved, would change their arguments in a way that is probably not wanted. What about making a LiveDevelopmentUtils with those two functions for now and let the multibrowser devs later on clean up and consolidate the duplicated code?

peterflynn · 2015-02-20T20:56:37Z

Yep, that's what I was proposing.

le717 · 2015-02-20T21:30:11Z

All done, commits flatten too. Ready for final review. :)

peterflynn · 2015-03-04T23:23:07Z

test/spec/LanguageManager-test.js

@@ -885,5 +885,45 @@ define(function (require, exports, module) {
                expect(LanguageManager.getLanguageForPath("test.abcxyz").isBinary()).toBeFalsy();
            });
        });
+
+        describe("getCompoundFileExtension", function () {


I think you still need to remove the original copy of this from FileUtils-test.

peterflynn · 2015-03-04T23:35:04Z

One last cleanup idea, if you want to add it in: move FileUtils.MAX_FILE_SIZE to AppShellFileSystem, since the limit is really impl-dependent (e.g. in-browser it might be lower). And then in FileUtils.getFileErrorString(), you'd reference it as require("fileSystemImpl").MAX_FILE_SIZE to stay agnostic of which impl is currently in use.

peterflynn · 2015-03-04T23:35:20Z

@le717 Thanks for this! Just a few small changes and then I think it's good to go.

le717 · 2015-03-04T23:43:44Z

You'd reference it as require("fileSystemImpl").MAX_FILE_SIZE to stay agnostic of which impl is currently in use.

But wouldn't this create a circular dependency, as Bracket's impl uses FileUtils.getNativeBracketsDirectoryPath() and FileUtils.getNativeModuleDirectoryPath()?

Otherwise, review changes pushed.

Move showFileOpenError() to DCH Update internal calls to getCompoundFileExtension() Relocate isCSSPreprocessorFile() Remove isCSSPreprocessorFile() redirect Update tests Introduce new LiveDevelopmentUtils module Redirect/remove _isStatic/ServerHtmlFileExt() Make _isStatic/ServerHtmlFileExt() use language id

le717 · 2015-03-04T23:55:49Z

I was right. Just performed those changes and Brackets locked up, with AppshellFileSystem throwing an "FileUtils is not defined" error, which means a circular dependency has been created (I've seen this error a lot throughout making this PR). Yet again, maybe another issue to file so a good fix can be discussed and put in place?

Ready for merging.

peterflynn · 2015-03-05T01:37:47Z

Ugh, that's a mess -- nothing in the filesystem package was supposed to have any dependencies on the rest of Brackets, originally. Scratch that change then -- leaving the const in FileUtils isn't so bad, and forks with a different fs impl can just change the constant there instead (they will have plenty of other diffs against master anyway).

peterflynn · 2015-03-06T06:20:17Z

Alright, looks great! Seems stable, tests pass -- thanks for cleaning this up!

Deprecate some circular dependencies with FileUtils so they can be removed later

le717 · 2015-03-06T15:40:57Z

src/LiveDevelopment/LiveDevelopmentUtils.js

+/*global define */
+
+/**
+ * Set of utilities for working with files and text content.


I just realized this module summary is completely wrong.

Oops, good catch -- feel free to put up a small PR with a fix.

le717 · 2015-03-06T15:54:00Z

I guess I should have titled this PR better, as this does not actually remove any circular dependencies. Rather, it moves some things around so the cycles can be removed.

How long do you think the warnings should stay in place? I know extensions need to be updated, but since removing the deprecated things and fixing the require calls will help improve the code base quality, there should be an ideal time for removal. I would say, if possible, v1.4, since I don't think you said too many extensions were affected here.

peterflynn · 2015-03-06T23:59:56Z

We usually leave deprecations for longer than that. It doesn't seem urgent to remove the shims since the existing async-loading workarounds work just fine, and the messy workaround code is very self-contained (i.e. the quality/maintainability impact is quite limited).

le717 · 2015-03-07T00:06:34Z

Ah, OK. My issue are there is no real guidelines as to when shims/deprecated items should be released. Obviously it will depend on the amount the APIs are used in extensions, but I'd still think there is an estimated/ideal time span before complete removal.

peterflynn · 2015-03-07T00:53:33Z

There's no specific standard timeframe, but I can't think of any case where we removed an API the very next release after it was deprecated. I'd say we usually wait a couple releases, then re-check how many current extensions are still using the APIs (if any) and make a decision from there.

@marcelgerber

* commit 'e56192e09ceed72834985f2483ed70e339e5c519': Logos are now perfectly centered Whitespace trimming suggested by @marcelgerber Fix some moved APIs that were left over from PR adobe#10641 Text is now perfectly centered

le717 mentioned this pull request Feb 20, 2015

[WIP] Introduce FilePathUtils module #10600

Closed

peterflynn reviewed Mar 4, 2015
View reviewed changes

peterflynn self-assigned this Mar 4, 2015

peterflynn added a commit that referenced this pull request Mar 6, 2015

Merge pull request #10641 from le717/remove-circular-deps

5daf5be

Deprecate some circular dependencies with FileUtils so they can be removed later

peterflynn merged commit 5daf5be into adobe:master Mar 6, 2015

le717 deleted the remove-circular-deps branch March 6, 2015 15:39

le717 reviewed Mar 6, 2015
View reviewed changes

peterflynn added a commit that referenced this pull request Mar 10, 2015

Fix some moved APIs that were left over from PR #10641

008a153

peterflynn mentioned this pull request Mar 10, 2015

Fix console deprecation warnings in core code #10729

Merged

AJDBenner pushed a commit to AJDBenner/brackets that referenced this pull request Apr 8, 2015

Fix some moved APIs that were left over from PR adobe#10641

88ccd2e

core-ai-bot mentioned this pull request Aug 30, 2021

[CLOSED] Remove some circular dependencies brackets-archive/bracketsIssues#9382

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove some circular dependencies #10641

Remove some circular dependencies #10641

le717 commented Feb 20, 2015

peterflynn commented Feb 20, 2015

le717 commented Feb 20, 2015

peterflynn commented Feb 20, 2015

le717 commented Feb 20, 2015

peterflynn commented Feb 20, 2015

le717 commented Feb 20, 2015

peterflynn Mar 4, 2015

peterflynn commented Mar 4, 2015

peterflynn commented Mar 4, 2015

le717 commented Mar 4, 2015

le717 commented Mar 4, 2015

peterflynn commented Mar 5, 2015

peterflynn commented Mar 6, 2015

le717 Mar 6, 2015

peterflynn Mar 6, 2015

le717 Mar 7, 2015

le717 commented Mar 6, 2015

peterflynn commented Mar 6, 2015

le717 commented Mar 7, 2015

peterflynn commented Mar 7, 2015

Remove some circular dependencies #10641

Remove some circular dependencies #10641

Conversation

le717 commented Feb 20, 2015

peterflynn commented Feb 20, 2015

le717 commented Feb 20, 2015

peterflynn commented Feb 20, 2015

le717 commented Feb 20, 2015

peterflynn commented Feb 20, 2015

le717 commented Feb 20, 2015

peterflynn Mar 4, 2015

Choose a reason for hiding this comment

peterflynn commented Mar 4, 2015

peterflynn commented Mar 4, 2015

le717 commented Mar 4, 2015

le717 commented Mar 4, 2015

peterflynn commented Mar 5, 2015

peterflynn commented Mar 6, 2015

le717 Mar 6, 2015

Choose a reason for hiding this comment

peterflynn Mar 6, 2015

Choose a reason for hiding this comment

le717 Mar 7, 2015

Choose a reason for hiding this comment

le717 commented Mar 6, 2015

peterflynn commented Mar 6, 2015

le717 commented Mar 7, 2015

peterflynn commented Mar 7, 2015