C Swift C++ Objective-C HTML JavaScript Other
Clone or download
Latest commit 0314a2c Aug 11, 2018
Permalink
Failed to load latest commit information.
.github 1.5 Release Nov 8, 2017
BraveShareTo Fix #438: allow to open in Brave more url types from other apps. (#1485 Apr 17, 2018
Certificates Merge branch 'development' into 1.6 (#1515) Apr 16, 2018
Client.xcodeproj Fish hashFn.h includes. Jul 2, 2018
Client Fix race condition for setting Domain color. Aug 7, 2018
ClientTests Merge from firefox master Feb 18, 2016
Crashlytics.framework Updated Fabric Apr 27, 2017
Fabric.framework Updated Fabric Apr 27, 2017
L10nSnapshotTests Bug 1245219 - (2/2) L10N Intro Screen Snapshot - Snapshot generation Feb 2, 2016
MarketingUITests Merge from fx master Jan 25, 2016
NativeRefTests Bug 1248990 - Re-record LoginTableViewCell snapshots to reflect new c… Feb 17, 2016
Providers 1.5 Release Nov 8, 2017
ReadingList update libs Jun 15, 2017
ReadingListTests Merge from fx master Jan 25, 2016
Shared Fix #1634: updated fallback icon logic. (#1644) Jun 28, 2018
SharedTests Bug 1223400 - Amend project to use carthage built dynamic frameworks Feb 12, 2016
Storage Fix #1551: Fallback favicon, generated from laptop's theme color scr… May 8, 2018
StorageTests No Bug - Resolved import errors when running tests Feb 16, 2016
ThirdParty Revert "Fix #1573: Using CCCalibratePBKDF to determine optimal rounds… May 17, 2018
UITests Enable Private Browsing and hookup some test cases Mar 8, 2016
Utils Fix #1677: Use main domain letter for fallback icons. (#1678) Jul 20, 2018
analytics 1.5.1 Release (#1352) Nov 28, 2017
brave Bumped version to 1.6.4. Aug 10, 2018
fastlane Bug 1228290 - add ability to take automated snapshots with Fastlane Dec 1, 2015
.gitignore Merge branch 'development' into 1.6 (#1515) Apr 16, 2018
.travis.yml Update .travis.yml Jun 3, 2015
AUTHORS Update AUTHORS Jan 29, 2015
AddToFavoritesActivity.swift Add 'add to favorites' share action. Jan 16, 2018
AlertPopupView.swift 1.5 Release Nov 8, 2017
Cartfile Fix #1527: Bip-39 for sync (#1514) Apr 19, 2018
Cartfile.resolved Fix #1527: Bip-39 for sync (#1514) Apr 19, 2018
Client-Bridging-Header.h Update URIFixup and NSURL utilities from fx master Oct 17, 2016
DeviceDetector.swift Make top sites scrollable, switch to Flow Layout. Jan 8, 2018
DeviceModelDetector.swift 1.5.4 release (#1462) Feb 23, 2018
Info.plist Bug 1247624 - Reset snapshot test schemes so that they run properly u… Feb 16, 2016
L10nSnapshotTests-Info.plist Bug 1247624 - Reset snapshot test schemes so that they run properly u… Feb 16, 2016
LICENSE Initial import Nov 4, 2014
LaunchScreen.storyboard apply new colors and icons Jan 22, 2018
README.md Updated README to contain deprecation information. (#1683) Jul 24, 2018
UIViewExtensions.swift Same, more swift3 Jun 28, 2017
ViewUtil.swift Fix #1409, done button bg color + sync screens layout improvements. (#… Jan 29, 2018
carthage.sh Add mixpanel back in Oct 20, 2016
checkout.sh Fixed checkout script invalid carthage command. (#1533) Apr 20, 2018

README.md

Brave iOS Browser

Download in the App Store

Brave is based on Firefox iOS, most of the Brave-specific code is in the brave dir

Deprecation Notice

This project is currently being deprecated and is being replaced by a new codebase. Please see brave-ios for our continued development work.

As of today, this is still the App Store version of Brave. High priority issues will continue to be fixed until Brave 2.0 replaces this repo on the App Store.

Labels

When looking at browser-ios issues some issues have been labeled with:
v2 Relevant: Issues that might be relevant for the new codebase. Some of these will be fixed here, and others may not be.
v2 Only: Issues that will not be fixed on this codebase, but will be addressed in the new repo.

Why the Change?

The primary reason for this project's deprecation is to support Apple's WKWebView. Brave iOS is still utilizing UIWebView, which contains many website comptability issues. Although it is possible to handle this upgrade on browser-ios, rebuilding from a new fork provides many useful advantages. The complexity of upgrading to WKWebView touches most of the current project, and this seemed like an obvious time to switch project bases.

Adding Brave to your app to open links

Either ensure your app supports opening urls in a share menu or use this project https://github.com/brave/ios-open-thirdparty-browser to open links directly.

Setup

1. Install Xcode from the AppStore

2. Install the latest LTS version of Node.js

3. Install Homebrew:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

4. Install Carthage:

brew install carthage

5. Download the source code:

git clone https://github.com/brave/browser-ios.git # this will download git if it isn't currently installed

6. Run the following commands:

cd browser-ios
./checkout.sh # this pulls Carthage dependencies
(cd brave && ./setup.sh your.fake.appid) # put in a fake unique app id if you want to build to device
open Client.xcodeproj

Note: building your own ad-hoc builds is supported see user device build

You will need a Apple developer account to run on your device.

Crash reporting using Fabric

To enable, add ~/.brave-fabric-keys with 2 lines, the API key and build secret. Re-run setup.sh and the project will be generated to use Fabric and Crashlytics frameworks.

Tests

Run Product>Test in Xcode to do so. Not all Firefox tests are passing yet.

Contribution Notes

Most of the code is in the brave/ directory. The primary design goal has been to preserve easy merging from Firefox iOS upstream, so hopefully code changes outside of that dir are minimal.

To find changes outside of brave/, look for #if BRAVE / #if !BRAVE (#if/#else/#endif is supported by Swift).

Adding Carthage modules

  1. Add line into Cartfile, run carthage bootstrap to update Cartfile.resolved
  2. Verify that your new module has been added to Cartfile.resolved
  3. Run checkout.sh
  4. In the Xcode Project, go to Client target settings, open the Build Phases tab and add a line such as
$(SRCROOT)/Carthage/Build/iOS/FRAMEWORKNAME.framework

Provisioning Profiles using a Team account

(This section doesn't apply to individual developer accounts, Xcode managed profiles seem to work fine in that case.)

Do not use 'Xcode managed profiles', there is no advantage to this, and debugging problems with that system is a dead end due to lack of transparency in that system.

brave/build-system/profiles has some handy scripts to download the adhoc or developer profiles and install them.

JS Tips

For anyone working with JS in iOS native, I recommend running and debugging your JS in an attached JS console. (Not using an edit/compile/debug cycle in Xcode). When you run from Xcode any iOS web view in the simulator (or attached device), you can then attach from Safari desktop (the Develop menu), and you get a JS console to work in.

We have various JS interpreters available: UIWebView, JavaScriptCore, and WKWebView.

The first is required if we are running JS on the web page, since we are using UIWebView. JavaScriptCore is a stand-alone JS engine that I believe is more up-to-date than UIWebView's. WKWebView will have the most modern JS engine, but requires instantiating a WKWebView for this purpose, which we would prefer to avoid as that is a heavy approach. UIWebView's JS engine is a few years old, and is quite primitive.

None of these are comparable to Safari iOS's JS engine, which is highly up-to-date in its capabilities but is not available to us.

Release Builds

brave/build-system/build-archive.sh does everything. When that completes, the Fabric app detects a new archive and asks to distribute to testers.

Misc Tips

If you get the dreaded "Launch Services Error 0": open ~/Library/Logs/CoreSimulator/CoreSimulator.log for info

Go to the Brave app folder for the most recently run simulator:

cd ~/Library/Developer/CoreSimulator/Devices && cd `ls -t | head -1` && cd data/Containers/Data/Application && cd `find . -iname "*brave*" | head -1 | xargs -I{} dirname {}`