pulse-browser / gluon

Build firefox forks with ease

Gluon

Build Firefox-based browsers with ease

This is still in a prerelease / prototype phase. Changes will be made, things will be broken

Installation

Per project (recommended):

npm install gluon-build
# or
yarn add gluon-build

Globally:

npm install -g gluon-build
# or
yarn global add gluon-build

# Note: Linux and mac users may have to run the above command with sudo

Documentation

Documentation is available on docs.gluon.dev or in the docs folder of this repository.

Licencing notes

The following is included in good faith. The writer is not a lawyer, and this is not legal advice.

Melon

Gluon has been extracted from melon, the build tool for the desktop version of Dot Browser under MPL v2.0.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Firefox

This program downloads and modifies Firefox. Follow their license when distributing your program.

Logo

The package icon is from Microsoft's Fluent Emoji. There is an ongoing conversation regarding the license.

MIT License

Copyright (c) Microsoft Corporation.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

gluon's Issues

UTF-8 error on gluon import

after running gluon import it exited with an error:

❯ gluon import
  ❯ Apply 1 branding patches
    ✖ Apply stable
      → provided data has not an UTF-8 encoding
    Apply 2 folder patches
    Apply 4 git patches

   ERROR An error occurred while running command ["import"]:

         Error: provided data has not an UTF-8 encoding
         

00:00:24 Exiting due to error.

I have made no changes to the code yet. Everything is automatically generated. Any help?

Reduce the number of dependancies

Currently, gluon requires 232 dependencies to work. This is absurd, so we should try pruning this down. The two packages that load the most dependencies are:

• Listr
• rimraf

We should remove both of these at some point

Importing patches in macos does not work

this is the error:

[FINISH] Apply 0 gluon patches
[START] Apply 2 branding patches

   ERROR An error occurred while running command ["import"]:

	 Error: Command failed: iconutil --convert icns --output '<src>/engine/browser/branding/alpha/firefox.icns' '<src>/.gluon/engine/macos_icon_info.iconset'
	 <src>/.gluon/engine/macos_icon_info.iconset:Failed to generate ICNS.
	 
	 
	 • ChildProcess.exithandler (node:child_process:402:[12])
	 • ChildProcess.emit (node:events:5[13])
	 • maybeClose (node:internal/child_process:1100:16)
	 • Process.ChildProcess._handle.onexit (node:internal/child_process:304:5)

00:00:01 Exiting due to error.

Ensure that `.gluon/` is in `.gitignore`

Do not crash if there is no commit

Some people are experiencing crashes when building without a commit. e.g.

Error: Command failed with exit code 128: git rev-parse HEAD
fatal: not a git repository (or any of the parent directories): .git

We should:

1. Check if it is in a git repo
2. Check if there is a commit

If neither of those conditions are met, we should warn the user and use a bogus commit hash (e.g. 0000000 or something)

Documentation shows a command that doesn't exist

Within the Branding your browser section of the guide, the invalid command "set" is shown.

Gluon Build Fails

I tried running gluon download again and it says SUCCESS You should be ready to make changes to Onyx.
Instead, when I run "gluon build" I get

The gluon issue tracker is located at: https://github.com/pulse-browser/gluon/issues
ERROR An error occurred while running command ["build"]:
Error: ENOENT: no such file or directory, scandir 'F:\Dev\Onyx-Browser\Onyx\src
00:00:00 Exiting due to error.```

`setup-project` does not ask for binary name

about gluon ...

Will there be a Windows version?

Will there be a Portable version?

Will there be a Traditional Chinese interface?

.

Gluon package fails with Python >=3

Tested on Windows 11 latest, on MozillaBuild latest.
This is fixed if you change the code in base.py to next().

Gluon Import error

Hi
I'm having an error doing the command "gluon import"
https://docs.gluon.dev/getting-started/overview/#getting-started-with-gluon

I followed that guide
   ERROR An error occurred while running command ["import"]:

         Error: ENOENT: no such file or directory, scandir 'C:\Users\hugof\OneDrive\Escritorio\Risirium\src'


00:00:00 Exiting due to error.

That is the output
and there is not any src dir
I executed before 2 commands
gluon download -> Without any error
gluon bootstrap -> Without any error

Fix windows

Windows Builds on gluon don't work due to having commands from linux.

License check: `--fix` fails

Running gluon license-check --fix will fail because license-check.txt (the MPL header) is not included in the NPM builds anymore

unknown error? help

WARNING It is recommended that you provide a binaryName field in your config file, otherwise packaging may get messed up
00:00:00 Bootstrapping NexBen...
Passing through to |mach bootstrap|
00:00:02 fatal: your current branch 'nexben' does not have any commits yet
00:00:02 Error running mach:
00:00:02
00:00:02 mach bootstrap --application-choice browser
00:00:02
00:00:02 The error occurred in code that was called by the mach command. This is either
00:00:02 a bug in the called code itself or in the way that mach is calling it.
00:00:02 You can invoke ./mach busted to check if this issue is already on file. If it
00:00:02 isn't, please use ./mach busted file bootstrap to report it. If ./mach busted is
00:00:02 misbehaving, you can also inspect the dependencies of bug 1543241.
00:00:02
00:00:02 If filing a bug, please include the full output of mach, including this error
00:00:02 message.
00:00:02
00:00:02 The details of the failure are as follows:
00:00:02
00:00:02 subprocess.CalledProcessError: Command '('C:\Program Files\Git\cmd\git.EXE', 'log', '-1', '--format=%ct')' returned non-zero exit status 128.
00:00:02
00:00:02 File "C:\Users\alexa\Downloads\nexben\engine\python\mozboot\mozboot\mach_commands.py", line 50, in bootstrap
00:00:02 bootstrapper.bootstrap(command_context.settings)
00:00:02 File "c:\users\alexa\downloads\nexben\engine\python\mozboot\mozboot\bootstrap.py", line 414, in bootstrap
00:00:02 (checkout_type, checkout_root) = current_firefox_checkout(
00:00:02 ^^^^^^^^^^^^^^^^^^^^^^^^^
00:00:02 File "c:\users\alexa\downloads\nexben\engine\python\mozboot\mozboot\bootstrap.py", line 684, in current_firefox_checkout
00:00:02 _warn_if_risky_revision(path)
00:00:02 File "c:\users\alexa\downloads\nexben\engine\python\mozboot\mozboot\bootstrap.py", line 833, in warn_if_risky_revision
00:00:02 if (time.time() - repo.get_commit_time()) >= NUM_SECONDS_IN_MONTH:
00:00:02 ^^^^^^^^^^^^^^^^^^^^^^
00:00:02 File "c:\users\alexa\downloads\nexben\engine\python\mozversioncontrol\mozversioncontrol_init.py", line 744, in get_commit_time
00:00:02 return int(self.run("log", "-1", "--format=%ct").strip())
00:00:02 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
00:00:02 File "c:\users\alexa\downloads\nexben\engine\python\mozversioncontrol\mozversioncontrol_init.py", line 110, in _run
00:00:02 return subprocess.check_output(
00:00:02 ^^^^^^^^^^^^^^^^^^^^^^^^
00:00:02 File "C:\Users\alexa\AppData\Local\Programs\Python\Python311\Lib\subprocess.py", line 465, in check_output
00:00:02 return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
00:00:02 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
00:00:02 File "C:\Users\alexa\AppData\Local\Programs\Python\Python311\Lib\subprocess.py", line 569, in run
00:00:02 raise CalledProcessError(retcode, process.args,

Add hard reset to melon

This issue has been created for tracking purposes

Intermitent download failures on macOS

Currently downloading addons from GitHub will cause intermittent failures because the user-agent has not been set.

00:12:58 Switched to a new branch 'pulse'
 WARNING The following error occurred whilst fetching github metadata

   ERROR An error occurred while running command ["download"]:

	 Error: Request failed with status code 403
	 
	 • settle (/Users/runner/work/browser/browser/node_modules/axios/lib/core/settle.js:17:12)
	 • IncomingMessage.handleStreamEnd (/Users/runner/work/browser/browser/node_modules/axios/lib/adapters/http.js:269:11)
	 • IncomingMessage.emit (node:events:525:35)
	 • endReadableNT (node:internal/streams/readable:1358:12)
	 • processTicksAndRejections (node:internal/process/task_queues:83:21)

00:12:58 Exiting due to error.
error Command failed with exit code 1.

Default source repo

The default source repo in configs/common/mozconfig is still dot browser. This should be changed

Installing gluon with npm fails

It looks like there is a problem with installing gluon with NPM.
From the error message, I guess it is a problem with a git repository not public anymore.
Installation with yarn works correctly.
Installation without -g flag works correctly.
The OS used is Arch Linux.

Windows build fails

Trying to build for windows, but fails, here is the output

lld-link: error: undefined symbol: __declspec(dllimport) NtWriteFile
referenced by /rustc/90c541806f23a127002de5b4038be731ba1458ca/library\std\src\sys\windows\stdio.rs:99
builtins_static.lib(builtins_static-147ba1f76cfe220b.smallvec-1b1f93064a56bee5.smallvec.0aa898c2-cgu.0.rcgu.o.rcgu.o):(std::sys::windows::stdio::write::h3c0a0f8c7c3063c9)
lld-link: error: undefined symbol: __declspec(dllimport) RtlNtStatusToDosError
referenced by /rustc/90c541806f23a127002de5b4038be731ba1458ca/library\std\src\sys\windows\stdio.rs:99
builtins_static.lib(builtins_static-147ba1f76cfe220b.smallvec-1b1f93064a56bee5.smallvec.0aa898c2-cgu.0.rcgu.o.rcgu.o):(std::sys::windows::stdio::write::h3c0a0f8c7c3063c9)
mozmake[4]: *** [H:/0xGingi-Browser/0xgingi-browser/engine/config/rules.mk:535: nssckbi.dll] Error 1
mozmake[3]: *** [H:/0xGingi-Browser/0xgingi-browser/engine/config/recurse.mk:72: security/manager/ssl/builtins/dynamic-library/target] Error 2
mozmake[3]: *** Waiting for unfinished jobs....
mozmake[2]: *** [H:/0xGingi-Browser/0xgingi-browser/engine/config/recurse.mk:34: compile] Error 2
mozmake[1]: *** [H:/0xGingi-Browser/0xgingi-browser/engine/config/rules.mk:361: default] Error 2
mozmake: *** [client.mk:60: build] Error 2

Does not appear to be working on Windows 11

Possible Windows issue

I have installed the required dependencies and followed all the instructions, but it does not work.

(latest mozillabuild version)

yarn version:

choco version:

All steps go fine until gluon download, where this error happens:

I have tried resetting the folder and re-configuring the gluon project but it doesn't seem to affect anything.

Custom CSS imports

It looks like the custom css routes are improperly routed or something else is going on as the shared route under custom does not apply to version 113.

Update template for `106`

The template contains failing patches for `106``